package LinkedList;

import java.util.*;
import java.util.function.Consumer;

//双链表
public class LinkedList<E>
        extends AbstractSequentialList<E>
        implements List<E>, Deque<E>, Cloneable, java.io.Serializable {
    //transient：表示不被序列化
    transient int size = 0;//链表元素个数

    /**
     * 维持为一个不变量：(first == null && last == null) || (first.prev == null && first.item != null)
     * */
    transient Node<E> first;//指向第一个节点的指针
    /**
     * 维持为一个不变量：(first == null && last == null) ||(last.next == null && last.item != null)
     * */
    transient Node<E> last;//指向最后一个元素的指针

    public LinkedList() {}//构造一个空列表

    //构造一个包含指定元素的列表
    public LinkedList(Collection<? extends E> c) {//如果找不到该指定的元素，则抛出空指向异常
        this();
        //利用迭代器按照集合顺序,讲其元素放入此列表集合
        addAll(c);
    }

    //定义一个节点
    private static class Node<E> {  //由于链表索引没有语意，所以利用Node节点类来表示位置的关系
        E item; //节点
        Node<E> next; //指向该节点的下一个位置的指针
        Node<E> prev; //指向该节点的上一个位置的指针

        Node(Node<E> prev, E element, Node<E> next) {//用户对节点信息进行赋值
            this.item = element;
            this.next = next;
            this.prev = prev;
        }
    }


    //向链表头添加元素。时间复杂度为O(1)
    private void linkFirst(E e) {
        final Node<E> f = first; //利用final来修饰这个节点类，使其成为一个开始节点，状态不可变
        final Node<E> newNode = new Node<E>(null, e, f); //用户为头结点传入一个元素
        first = newNode;//首先让指针first指向该新节点，记住此时还没有对新节点进行元素添加操作,两个指针的指向确定后才能表示该元素在该新节点上添加成功
        if (f == null)  //如果第一个节点位置为空
            last = newNode;//令last指向该新节点
        else
            f.prev = newNode;//否则，把原来的first的prev指向新节点，把新节点作为新的first节点
        size++;//完成添加操作，维护size
        modCount++;//修改次数+1
    }

    //向链表尾部添加元素。时间复杂度为O(1)
    void linkLast(E e) {
        final Node<E> l = last;//使其成为一个结束节点
        final Node<E> newNode = new Node<E>(l, e, null);//用户为尾节点传入一个元素
        last = newNode;//首先让指针last指向该新节点
        if (l == null)//如果尾节点为空
            first = newNode;//令first指向该新节点，因为没有尾节点就代表链条为空
        else
            l.next = newNode;//否则令原来的last的next指向新节点，把新节点作为新的last节点
        size++;
        modCount++;
    }

    //在非空节点succ之前插入元素e。时间复杂度为O(1)
    void linkBefore(E e, Node<E> succ) {
        //assert succ != null：才会有succ.prev
        final Node<E> pred = succ.prev;//使其成为非空节点succ前一节点
        final Node<E> newNode = new Node<E>(pred, e, succ);//用户在succ.prev位置上传入一个元素
        succ.prev = newNode;//令succ.prev指向该新节点对象
        if (pred == null)//如果非空节点的prev是null，说明它是第一个节点
            first = newNode;//说明非空节点是first节点，令first指向该新节点
        else
            pred.next = newNode;//否则，就让这个非空节点的next指向该新节点
        size++;
        modCount++;
    }

    //删除一个非空的first节点f。时间复杂度为O(1)
    private E unlinkFirst(Node<E> f) {

        // assert f == first && f != null;
        final E element = f.item; //定义该要删除的第一个非空节点元素f.item
        final Node<E> next = f.next;//使其成为该删除节点的下一个节点
        f.item = null; //移除该节点元素
        f.next = null; //移除该节点的指针
        first = next;  //将该节点的指针指向其下一个节点对象
        if (next == null)//如果没有下一个节点
            last = null; //则表示链表只有该节点对象，所以first与last都是指向该节点，移除该指向
        else
            next.prev = null;//否则，移除该节点的，下一个节点的，指向该要删除的节点，的指针，有点绕，不过想一想就很简单了。
        size--;
        modCount++;
        return element;
    }

    //删除一个非空的last节点。时间复杂度为O(1)
    private E unlinkLast(Node<E> l) {

        // assert l == last && l != null
        final E element = l.item;//定义要删除的最后一个非空节点元素l.item
        final Node<E> prev = l.prev;//使其成为该删除节点的上一个节点
        l.item = null; //移除该节点元素
        l.prev = null;  //移除该节点的指针
        last = prev; //将该节点的指针指向其上一个节点对象
        if (prev == null)//如果上一个节点为空，则说明该列表就只有该节点对象
            first = null;//移除first指向
        else
            prev.next = null;//否则，移除l.prev.next
        size--;
        modCount++;
        return element;
    }

    //删除一个非空节点。时间复杂度为O(1)
    E unlink(Node<E> x) {

        // assert x != null;
        final E element = x.item;//定义要删除的节点元素x.item
        final Node<E> next = x.next;//该节点的下一个指向
        final Node<E> prev = x.prev;//该节点的上一个指向

        if (prev == null) {//说明是第一个节点
            first = next;//令first指向该节点的下一个节点
        } else {
            prev.next = next;//否则令x.next指向该元素原先的节点位置
            x.prev = null; //移除该节点的指向
        }
        if (next == null) {//说明是最后一个节点
            last = prev;  //令last指向该节点的上一个节点
        } else {
            next.prev = prev; //否则令x.prev指向该元素原先的节点位置
            x.next = null; //移除该节点的指针
        }
        x.item = null; //移除该节点元素
        size--;
        modCount++;
        return element;
    }

    //返回此列表中的第一个元素。时间复杂度为O(1)
    public E getFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return f.item;
    }

    //返回此列表中的最后一个元素。时间复杂度为O(1)
    public E getLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return l.item;
    }

    //从此列表中删除并返回第一个元素。时间复杂度为O(1)
    public E removeFirst() {
        final Node<E> f = first;
        if (f == null)
            throw new NoSuchElementException();
        return unlinkFirst(f);
    }

    //从此列表中删除并返回最后一个元素。时间复杂度为O(1)
    public E removeLast() {
        final Node<E> l = last;
        if (l == null)
            throw new NoSuchElementException();
        return unlinkLast(l);
    }

    //将指定的元素追加到此列表的末尾。时间复杂度为O(1)
    public boolean add(E e) {
        linkLast(e);
        return true;
    }

    //在此列表的开头插入指定的元素。时间复杂度为O(1)
    public void addFirst(E e) {
        linkFirst(e);
    }

    //将指定的元素追加到此列表的末尾。时间复杂度为O(1)
    public void addLast(E e) {
        linkLast(e);
    }

    //如果此列表包含指定的元素，则返回true。时间复杂度为O(n)
    public boolean contains(Object o) {
        return indexOf(o) != -1;
    }

    //返回此列表中的元素数。
    public int size() {
        return size;
    }

    //从此列表中删除指定元素的第一个匹配项（如果存在）。时间复杂度为O(n)
    public boolean remove(Object o) {
        if (o == null) {
            for (Node<E> x = first; x != null; x = x.next) { //从头开始寻找
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

    //将指定集合中的所有元素按指定集合的​​迭代器返回的顺序附加到此列表的末尾。
    public boolean addAll(Collection<? extends E> c) {
        return addAll(size, c);
    }

    //从指定位置开始，将指定集合中的所有元素插入此列表。时间复杂度为O(n^2)
    public boolean addAll(int index, Collection<? extends E> c) {
        //判断index是否合法
        checkPositionIndex(index);

        Object[] a = c.toArray(); //将集合元素存进对象数组中，数组查询快，更便捷
        int numNew = a.length; //定义数组长度
        if (numNew == 0)
            return false;

        /**
         * succ：待添加节点的位置
         * pred：待添加节点的前一个节点
         * */
        Node<E> pred, succ;  //定义两个节点类对象
        if (index == size) {//说明需要添加的元素都在LinkedList中的最后面
            succ = null;//待添加节点的位置为空
            pred = last;//last指向pred
        } else {//新添加的元素位于LinkedList中
            succ = node(index);//将指定元素索引处的非空节点成为待添加的节点
            pred = succ.prev;//令succ.prev指向pred
        }

        for (Object o : a) {//遍历数组
            @SuppressWarnings("unchecked") E e = (E) o;//令数组元素转型为列表节点元素
            Node<E> newNode = new Node<E>(pred, e, null);//每次遍历都要新建一个节点，该节点为最后一个节点
            if (pred == null) //如果没有前一个节点，表明该节点为第一个节点
                first = newNode;//令first指向该节点
            else
                pred.next = newNode;//否则pred.next指向该节点
            pred = newNode; //为方便后面节点的添加操作，这里添加的节点会成为下一个添加节点的前一个节点
        }

        if (succ == null) {//如果要添加的元素为null,则直接last指向pred
            last = pred;
        } else {
            pred.next = succ;//否则，pred.next就是要添加节点的位置
            succ.prev = pred;//令succ.prev指向pred
        }

        size += numNew;
        modCount++;
        return true;
    }

    //返回指定元素索引处的(非空)节点。时间复杂度为O(n)
    Node<E> node(int index) {
        /**
         * 分为前后两部分   index < 0.5*size    index > 0.5size
         * 这样就不用遍历整个链表了
         * */
        if (index < (size >> 1)) {  //元素在前一部分
            Node<E> x = first; //定义头结点
            for (int i = 0; i < index; i++) //从头节点开始遍历，直到找到该合适位置位为止
                x = x.next;
            return x;//遍历结束，返回index位置的节点
        } else {//元素在后一部分
            Node<E> x = last; //定义尾结点
            for (int i = size - 1; i > index; i--)//从尾结点往前开始遍历，直到找到该合适位置位为止
                x = x.prev;
            return x;
        }
    }

    //从此列表中删除所有元素。时间复杂度为O(n)
    public void clear() {
        for (Node<E> x = first; x != null; ) {
            Node<E> next = x.next;
            x.item = null; //清除整个节点信息
            x.next = null;
            x.prev = null;
            x = next;
        }
        first = last = null;
        size = 0;
        modCount++;
    }

    //返回此列表中指定位置的元素。时间复杂度为O(n)
    public E get(int index) {
        checkElementIndex(index);
        return node(index).item;//找到返回该节点元素
    }

    //用指定的元素替换此列表中指定位置的元素。时间复杂度为O(n)
    public E set(int index, E element) {
        checkElementIndex(index);
        Node<E> x = node(index);//找到旧值
        E oldVal = x.item;
        x.item = element;//替换新值
        return oldVal;//返回旧值
    }

    //将指定元素插入此列表中的指定位置。
    public void add(int index, E element) {
        checkPositionIndex(index);
        if (index == size)
            linkLast(element);//时间复杂度为O(1)
        else
            linkBefore(element, node(index));//时间复杂度为O(n)
    }

    //删除此列表中指定位置的元素。时间复杂度为O(n)
    public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }

    //说明参数是否为现有元素的索引
    private boolean isElementIndex(int index) {
        return index >= 0 && index < size;
    }

    //判断该节点位置是否在限制范围内
    private boolean isPositionIndex(int index) {
        return index >= 0 && index <= size;
    }

    /**
     * 构造IndexOutOfBoundsException详细信息。
     * 对错误处理程式码可能进行的多项重构，
     * 这种“大纲”在服务器和客户端vm上都表现得最好
     * */
    private String outOfBoundsMsg(int index) {
        return "Index: "+index+", Size: "+size;
    }

    //判断参数是否为现有元素的索引
    private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    //判断该节点位置是否在限制范围内
    private void checkPositionIndex(int index) {
        if (!isPositionIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }

    //返回此列表中第一次出现的指定元素的索引，如果此列表不包含该元素，则返回-1。时间复杂度为O(n)
    public int indexOf(Object o) {
        int index = 0;
        if (o == null) {//用户传入的节点元素为null
            for (Node<E> x = first; x != null; x = x.next) {
                if (x.item == null)//如果遍历到最后一个节点
                    return index;
                index++; //这里的index放在判断语句后，是因为index是从0开始的，index与节点元素索引值匹配
            }
        } else {
            for (Node<E> x = first; x != null; x = x.next) {
                if (o.equals(x.item)) //比对
                    return index;
                index++;
            }
        }
        return -1;
    }

    //返回此列表中指定元素最后一次出现的索引，如果此列表不包含该元素，则返回-1。时间复杂度为O(n)
    public int lastIndexOf(Object o) {
        int index = size; //从尾部开始往前遍历，遍历操作与indexOf一样
        if (o == null) {
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;//这里的index放在判断语句前，因为size-1就为最后一个节点元素的索引
                if (x.item == null)
                    return index;
            }
        } else {
            for (Node<E> x = last; x != null; x = x.prev) {
                index--;
                if (o.equals(x.item))
                    return index;
            }
        }
        return -1;
    }

    //检索但不删除此列表的头部（第一个元素）。时间复杂度为O(1)
    public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item; //返回头结点的值
    }

    //检索但不删除此列表的头部（第一个元素）.时间复杂度为O(1)
    public E element() {
        return getFirst();
    }

    //检索并删除此列表的头部（第一个元素）。时间复杂度为O(1)
    public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

    //检索并删除此列表的头部（第一个元素）。时间复杂度为O(1)
    public E remove() {
        return removeFirst();
    }

    //将指定的元素添加为此列表的尾部（最后一个元素）。时间复杂度为O(1)
    public boolean offer(E e) {
        return add(e);
    }

    //在指定列表的前面插入指定的元素。时间复杂度为O(1)
    public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }

    //在此列表的末尾插入指定的元素。时间复杂度为O(1)
    public boolean offerLast(E e) {
        addLast(e);
        return true;
    }

    //检索但不删除此列表的第一个元素，null如果此列表为空，则返回。时间复杂度为O(1)
    public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }

     //检索但不删除此列表的最后一个元素，null如果此列表为空，则返回。时间复杂度为O(1)
    public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }

     //检索并删除此列表的第一个元素，null如果此列表为空，则返回。时间复杂度为O(1)
    public E pollFirst() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }

     //检索并删除此列表的最后一个元素，null如果此列表为空，则返回。时间复杂度为O(1)
    public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }

     //将元素推送到此列表所表示的堆栈上。时间复杂度为O(1)
    public void push(E e) {
        addFirst(e);
    }

     //弹出此列表所代表的堆栈中的元素。时间复杂度为O(1)
    public E pop() {
        return removeFirst();
    }

     //删除此列表中第一次出现的指定元素（从头到尾遍历列表时）。时间复杂度为O(n)
    public boolean removeFirstOccurrence(Object o) {
        return remove(o);
    }

     //删除此列表中最后一次出现的指定元素（从头到尾遍历列表时）。时间复杂度为O(n)
    public boolean removeLastOccurrence(Object o) {
        if (o == null) {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (x.item == null) {
                    unlink(x);
                    return true;
                }
            }
        } else {
            for (Node<E> x = last; x != null; x = x.prev) {
                if (o.equals(x.item)) {
                    unlink(x);
                    return true;
                }
            }
        }
        return false;
    }

     //从列表中的指定位置开始，返回此列表中元素的列表迭代器（按正确顺序）。
    public ListIterator<E> listIterator(int index) {
        checkPositionIndex(index);
        return new ListItr(index);
    }

    private class ListItr implements ListIterator<E> {
        private Node<E> lastReturned;
        private Node<E> next;
        private int nextIndex;
        private int expectedModCount = modCount;

        ListItr(int index) {
 
            next = (index == size) ? null : node(index);
            nextIndex = index;
        }

        public boolean hasNext() {
            return nextIndex < size;
        }

        public E next() {
            checkForComodification();
            if (!hasNext())
                throw new NoSuchElementException();

            lastReturned = next;
            next = next.next;
            nextIndex++;
            return lastReturned.item;
        }

        public boolean hasPrevious() {
            return nextIndex > 0;
        }

        public E previous() {
            checkForComodification();
            if (!hasPrevious())
                throw new NoSuchElementException();

            lastReturned = next = (next == null) ? last : next.prev;
            nextIndex--;
            return lastReturned.item;
        }

        public int nextIndex() {
            return nextIndex;
        }

        public int previousIndex() {
            return nextIndex - 1;
        }

        public void remove() {
            checkForComodification();
            if (lastReturned == null)
                throw new IllegalStateException();

            Node<E> lastNext = lastReturned.next;
            unlink(lastReturned);
            if (next == lastReturned)
                next = lastNext;
            else
                nextIndex--;
            lastReturned = null;
            expectedModCount++;
        }

        public void set(E e) {
            if (lastReturned == null)
                throw new IllegalStateException();
            checkForComodification();
            lastReturned.item = e;
        }

        public void add(E e) {
            checkForComodification();
            lastReturned = null;
            if (next == null)
                linkLast(e);
            else
                linkBefore(e, next);
            nextIndex++;
            expectedModCount++;
        }

        public void forEachRemaining(Consumer<? super E> action) {
            Objects.requireNonNull(action);
            while (modCount == expectedModCount && nextIndex < size) {
                action.accept(next.item);
                lastReturned = next;
                next = next.next;
                nextIndex++;
            }
            checkForComodification();
        }

        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

    public Iterator<E> descendingIterator() {
        return new DescendingIterator();
    }

    //以相反的顺序返回此双端队列中元素的迭代器。
    private class DescendingIterator implements Iterator<E> {
        private final ListItr itr = new ListItr(size());
        public boolean hasNext() {
            return itr.hasPrevious();
        }
        public E next() {
            return itr.previous();
        }
        public void remove() {
            itr.remove();
        }
    }

    @SuppressWarnings("unchecked")
    private LinkedList<E> superClone() {
        try {
            return (LinkedList<E>) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(e);
        }
    }

    //返回此的拷贝副本LinkedList,浅拷贝
    public Object clone() {
        LinkedList<E> clone = superClone();//获取从辅助方法返回的LinkedList对象

        //将克隆体放入初始状态
        clone.first = clone.last = null;
        clone.size = 0;
        clone.modCount = 0;

        //用我们自己的节点元素初始化克隆
        for (Node<E> x = first; x != null; x = x.next)
            clone.add(x.item); //往clone对象添加内容

        return clone;
    }

     //以适当的顺序（从第一个元素到最后一个元素）返回包含此列表中所有元素的数组
    public Object[] toArray() {
        Object[] result = new Object[size];
        int i = 0;
        //通过遍历LinkedList中的每个节点，把值添加到数组中。
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;
        return result;
    }

     //以适当的顺序返回包含此列表中所有元素的数组（从第一个元素到最后一个元素）;
     //返回数组的运行时类型是指定数组的运行时类型。
    @SuppressWarnings("unchecked")
    public <T> T[] toArray(T[] a) {
        if (a.length < size)//如果a的长度小于集合的大小
            //通过反射创建一个和集合同样大小的数组，
            a = (T[])java.lang.reflect.Array.newInstance(
                    a.getClass().getComponentType(), size);
        int i = 0;
        //接着把集合中的所有元素添加到数组中。
        Object[] result = a;
        //通过遍历LinkedList中的每个节点，把值添加到数组中。
        for (Node<E> x = first; x != null; x = x.next)
            result[i++] = x.item;

        //如果数组的元素的个数大于集合中元素的个数，则把a[size]设置为空。
        if (a.length > size)
            a[size] = null;

        return a;
    }

    private static final long serialVersionUID = 876323262645176354L;

    private void writeObject(java.io.ObjectOutputStream s)//序列化
            throws java.io.IOException {
 
        s.defaultWriteObject();

        s.writeInt(size);

        for (Node<E> x = first; x != null; x = x.next)
            s.writeObject(x.item);
    }

    @SuppressWarnings("unchecked")
    private void readObject(java.io.ObjectInputStream s)//反序列化
            throws java.io.IOException, ClassNotFoundException {
 
        s.defaultReadObject();

        int size = s.readInt();

        for (int i = 0; i < size; i++)
            linkLast((E)s.readObject());
    }

     //在此列表中的元素上创建后期绑定 和失败快速 Spliterator。
    @Override
    public Spliterator<E> spliterator() {
        return new LLSpliterator<E>(this, -1, 0);
    }

    static final class LLSpliterator<E> implements Spliterator<E> {
        static final int BATCH_UNIT = 1 << 10; 
        static final int MAX_BATCH = 1 << 25; 
        final LinkedList<E> list; 
        Node<E> current; 
        int est; 
        int expectedModCount; 
        int batch; 

        LLSpliterator(LinkedList<E> list, int est, int expectedModCount) {
            this.list = list;
            this.est = est;
            this.expectedModCount = expectedModCount;
        }

        final int getEst() {
            int s; 
            final LinkedList<E> lst;
            if ((s = est) < 0) {
                if ((lst = list) == null)
                    s = est = 0;
                else {
                    expectedModCount = lst.modCount;
                    current = lst.first;
                    s = est = lst.size;
                }
            }
            return s;
        }

        public long estimateSize() { return (long) getEst(); }

        public Spliterator<E> trySplit() {
            Node<E> p;
            int s = getEst();
            if (s > 1 && (p = current) != null) {
                int n = batch + BATCH_UNIT;
                if (n > s)
                    n = s;
                if (n > MAX_BATCH)
                    n = MAX_BATCH;
                Object[] a = new Object[n];
                int j = 0;
                do { a[j++] = p.item; } while ((p = p.next) != null && j < n);
                current = p;
                batch = j;
                est = s - j;
                return Spliterators.spliterator(a, 0, j, Spliterator.ORDERED);
            }
            return null;
        }

        public void forEachRemaining(Consumer<? super E> action) {
            Node<E> p; int n;
            if (action == null) throw new NullPointerException();
            if ((n = getEst()) > 0 && (p = current) != null) {
                current = null;
                est = 0;
                do {
                    E e = p.item;
                    p = p.next;
                    action.accept(e);
                } while (p != null && --n > 0);
            }
            if (list.modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }

        public boolean tryAdvance(Consumer<? super E> action) {
            Node<E> p;
            if (action == null) throw new NullPointerException();
            if (getEst() > 0 && (p = current) != null) {
                --est;
                E e = p.item;
                current = p.next;
                action.accept(e);
                if (list.modCount != expectedModCount)
                    throw new ConcurrentModificationException();
                return true;
            }
            return false;
        }

        public int characteristics() {
            return Spliterator.ORDERED | Spliterator.SIZED | Spliterator.SUBSIZED;
        }
    }

}
